package com.ruoyi.system.api;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestParam;
import com.ruoyi.common.core.constant.SecurityConstants;
import com.ruoyi.common.core.constant.ServiceNameConstants;
import com.ruoyi.common.core.domain.R;
import com.ruoyi.system.api.factory.RemoteSmsFallbackFactory;

/**
 * 短信服务远程调用接口
 * 
 * @author ruoyi
 */
@FeignClient(contextId = "remoteSmsService", value = ServiceNameConstants.SYSTEM_SERVICE, fallbackFactory = RemoteSmsFallbackFactory.class)
public interface RemoteSmsService {

    /**
     * 发送验证码（自动生成）
     *
     * @param phoneNumber 手机号
     * @return 发送结果
     */
    @PostMapping("/sms/sendCode")
    R<String> sendVerificationCode(@RequestParam("phoneNumber") String phoneNumber);

    /**
     * 发送指定验证码
     *
     * @param phoneNumber 手机号
     * @param code 验证码
     * @return 发送结果
     */
    @PostMapping("/sms/sendCodes")
    R<String> sendVerificationCode(@RequestParam("phoneNumber") String phoneNumber,
                                  @RequestParam("code") String code);

    /**
     * 校验验证码
     *
     * @param phoneNumber 手机号
     * @param code 验证码
     * @return 校验结果
     */
    @PostMapping("/sms/verify")
    R<String> verifyCode(@RequestParam("phoneNumber") String phoneNumber,
                        @RequestParam("code") String code);

    /**
     * 获取短信发送状态
     *
     * @param phoneNumber 手机号
     * @return 状态信息
     */
    @GetMapping("/sms/status")
    R<String> getSmsStatus(@RequestParam("phoneNumber") String phoneNumber);
}